.. _cmmSxOptGetSyncOut:

cmmSxOptGetSyncOut
=====================
---------------------


SYNOPSYS
`````````

.. code-block:: none

    VT_I4 cmmSxOptGetSyncMode(
        [in] VT_I4 Axis, [out] VT_PI4 Mode, [out] VT_PI4 RefAxis, [out] VT_PI4 Condition
        )


DESCRIPTION
`````````````

- 지정한 축에 대하여 이송명령을 전달되었을 때 이송동작의 시작이 다른축(Other Axis)의 동작 상황에 동기되어
  시작되도록 할 때 사용하는 함수입니다. 예를 들어 X 축의 이송시작이 Y 축의 가속이 완료되는 시점 또는 감속이
  시작되는 시점에 수행되도록 하고자할 때 이 함수를 사용하면 해당 동작을 구현할 수 있습니다.

PARAMETER
```````````

- Axis: 축번호. 축번호는 상수값으로 [cmX1] 부터 0 번째 축을 기준 축으로 임의의 축을 설정할 수 있습니다.

\

- Mode : cmmSxOptSetSyncMode 함수의 인자이며, 동기모드를 지정합니다. 이 값의 의미는 다음과 같습니다. 

.. csv-table::
    :widths: 10 85
    :header-rows: 1
    :stub-columns: 0

    Value, Meaning
    "0", 동기모드를 사용하지 않는 상태입니다.
    "1", "Start by Internal Synch. Signal" 모드: 내부동기 신호에 의하여 이송이 시작되는 상태입니다.
    "|2", "
     |     “Start by Other Axis/Axes Stop” 모드: RefAxis 매개 변수에 의하여 지정된 축의
     |     이송이 완료될 때 이송을 시작하는 상태입니다."
          


- RefAxis : cmmSxOptGetSyncMode 함수의 인자이며, 내부 동기신호를 발생할 때 참조하는 축 번호 또는 마스크를 반환합니다.


- Condition : cmmSxOptGetSyncMod 함수의 인자이며, 반환하는 값의 의미는 다음과 같습니다.


.. csv-table::
    :widths: 10 85
    :header-rows: 1
    :stub-columns: 0

    Value, Meaning
    "0", 범용비교기의 조건이 충족되었을 때 이송을 시작합니다. 
    1, 참조축이 가속을 시작할 때 이송을 시작합니다. 
    2, 참조축이 가속을 끝내고 정속모드로 들어서는 순간에 이송을 시작합니다.
    3, 참조축이 감속을 시작할 때 이송을 시작합니다.
    4, 참조축이 감속을 시작할 때 이송을 시작합니다.
    5, -SL 신호가 검출되었을 때 이송을 시작합니다.
    6, +SL 신호가 검출되었을 때 이송을 시작합니다.
    7, 범용 비교기에 설정된 조건이 만족되었을 때 이송을 시작합니다.
    8, TRG-CMP 조건이 만족되었을 때 이송을 시작합니다.

RETURN VALUE
`````````````

+--------------+-----------+
| Value        | Meaning   |
+==============+===========+
| 음수         | 수행 실패 |
+--------------+-----------+
| cmERR_NONE   | 수행 성공 |
+--------------+-----------+


.. seealso:: :ref:`cmmSxOptSetSyncMode`